docs(SDK-549): document logout() as native logoutUser equivalent - #900
jferrao-itrbl wants to merge 1 commit into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
Coverage Impact This PR will not change total coverage. 🚦 See full report on Qlty Cloud »🛟 Help
|
franco-zalamena-iterable
left a comment
franco-zalamena-iterable
left a comment
There was a problem hiding this comment.
Just to double check some points
| * `logoutUser`; private `logoutPreviousUser()` runs as part of identity | ||
| * clear. | ||
| * | ||
| * iOS `logoutUser(withOnSuccess:onFailure:)` is not exposed. |
There was a problem hiding this comment.
From what i checked iOS does have a public logout method, it is just not exposed in the bridge, android actually doesn't have and maybe that's something for us to create a followup ticket to fix.
But i think we can rephrase this to make it more accurate and think of making it exposed through the bridge when we get both platforms
2 participants
📝 Summary
Document
Iterable.logout()as the RN equivalent of nativelogoutUser; no runtime or bridge change.🎟️ Jira Ticket: SDK-549
📖 Description
RN already ships
Iterable.logout(), which removes JS listeners and clears identity viasetEmail(null)+setUserId(null). That identity-clear path is the native logout cleanup on both platforms (auth reset, in-app/embedded reset, push disable whenautoPushRegistrationis on). Android has no publiclogoutUser.This PR only updates the
logout()JSDoc so that mapping is explicit, including:logoutUser(withOnSuccess:onFailure:)is not exposedlogout()with no signed-in user is safeNo new TurboModule method, no codegen, no behavior change.
🧪 How to test?
yarn typecheckyarn test(existinglogouttests insrc/core/classes/Iterable.test.ts)Iterable.logout()still callssetEmail(null)andsetUserId(null)🧾 Changelog
No customer facing changes
📹 Loom recording if applicable
N/A
🐞 Github Issues solved
N/A
📚 Docs PR if applicable
N/A — JSDoc only; no iterable-docs change.